Anomaly Detector Client (preview:1.1.2)

2025/10/21 • 32 deleted methods

DetectEntireSeries (removed)
Description :  This operation generates a model using the points that you sent into the API, and based on all data to determine whether the last point is anomalous. The latest point detecting operation matches the scenario of real-time monitoring of business metrics.
Reference :  Link ¶

⚼ Request

POST:  /timeseries/entire/detect
{
body:
{
Description: Time series points and period if needed. Advanced model parameters can also be set in the request. ,
Required: True ,
}
{
series:
{
Description: Time series data points. Points should be sorted by timestamp in ascending order to match the anomaly detection result. If the data is not sorted correctly or there is duplicated timestamp, the API will not work. In such case, an error message will be returned. ,
Required: True ,
}
[
{
timestamp:
{
Description: Optional argument, timestamp of a data point (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
value:
{
Description: The measurement of that point, should be float. ,
Format: float ,
Required: True ,
}
number ,
}
,
]
,
granularity:
{
Description: Optional argument, can be one of yearly, monthly, weekly, daily, hourly, minutely, secondly, microsecond or none. If granularity is not present, it will be none by default. If granularity is none, the timestamp property in time series point can be absent. ,
Enum:
{
yearly: No description available. ,
monthly: No description available. ,
weekly: No description available. ,
daily: No description available. ,
hourly: No description available. ,
minutely: No description available. ,
secondly: No description available. ,
microsecond: No description available. ,
none: No description available. ,
}
,
Required: False ,
}
enum ,
customInterval:
{
Description: Custom Interval is used to set non-standard time interval, for example, if the series is 5 minutes, request can be set as {"granularity":"minutely", "customInterval":5}. ,
Format: int32 ,
Required: False ,
}
integer ,
period:
{
Description: Optional argument, periodic value of a time series. If the value is null or does not present, the API will determine the period automatically. ,
Format: int32 ,
Required: False ,
}
integer ,
maxAnomalyRatio:
{
Description: Optional argument, advanced model parameter, max anomaly ratio in a time series. ,
Format: float ,
Required: False ,
}
number ,
sensitivity:
{
Description: Optional argument, advanced model parameter, between 0-99, the lower the value is, the larger the margin value will be which means less anomalies will be accepted. ,
Format: int32 ,
Required: False ,
}
integer ,
imputeMode:
{
Description: Used to specify how to deal with missing values in the input series, it's used when granularity is not "none". ,
Enum:
{
auto: No description available. ,
previous: No description available. ,
linear: No description available. ,
fixed: No description available. ,
zero: No description available. ,
notFill: No description available. ,
}
,
Required: False ,
}
enum ,
imputeFixedValue:
{
Description: Used to specify the value to fill, it's used when granularity is not "none" and imputeMode is "fixed". ,
Format: float ,
Required: False ,
}
number ,
}
,
}

⚐ Response (200)

{
period:
{
Description: Frequency extracted from the series, zero means no recurrent pattern has been found. ,
Format: int32 ,
Required: True ,
}
integer ,
expectedValues:
{
Description: ExpectedValues contain expected value for each input point. The index of the array is consistent with the input series. ,
Required: True ,
}
[
number ,
]
,
upperMargins:
{
Description: UpperMargins contain upper margin of each input point. UpperMargin is used to calculate upperBoundary, which equals to expectedValue + (100 - marginScale)*upperMargin. Anomalies in response can be filtered by upperBoundary and lowerBoundary. By adjusting marginScale value, less significant anomalies can be filtered in client side. The index of the array is consistent with the input series. ,
Required: True ,
}
[
number ,
]
,
lowerMargins:
{
Description: LowerMargins contain lower margin of each input point. LowerMargin is used to calculate lowerBoundary, which equals to expectedValue - (100 - marginScale)*lowerMargin. Points between the boundary can be marked as normal ones in client side. The index of the array is consistent with the input series. ,
Required: True ,
}
[
number ,
]
,
isAnomaly:
{
Description: IsAnomaly contains anomaly properties for each input point. True means an anomaly either negative or positive has been detected. The index of the array is consistent with the input series. ,
Required: True ,
}
[
boolean ,
]
,
isNegativeAnomaly:
{
Description: IsNegativeAnomaly contains anomaly status in negative direction for each input point. True means a negative anomaly has been detected. A negative anomaly means the point is detected as an anomaly and its real value is smaller than the expected one. The index of the array is consistent with the input series. ,
Required: True ,
}
[
boolean ,
]
,
isPositiveAnomaly:
{
Description: IsPositiveAnomaly contain anomaly status in positive direction for each input point. True means a positive anomaly has been detected. A positive anomaly means the point is detected as an anomaly and its real value is larger than the expected one. The index of the array is consistent with the input series. ,
Required: True ,
}
[
boolean ,
]
,
severity:
{
Description: The severity score for each input point. The larger the value is, the more sever the anomaly is. For normal points, the "severity" is always 0. ,
Required: False ,
}
[
number ,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: error code ,
}
string ,
}
,
$schema:
{
Description: Error information returned by the API. ,
}
{
code:
{
Description: The error code. ,
Enum:
{
InvalidCustomInterval: No description available. ,
BadArgument: No description available. ,
InvalidGranularity: No description available. ,
InvalidPeriod: No description available. ,
InvalidModelArgument: No description available. ,
InvalidSeries: No description available. ,
InvalidJsonFormat: No description available. ,
RequiredGranularity: No description available. ,
RequiredSeries: No description available. ,
InvalidImputeMode: No description available. ,
InvalidImputeFixedValue: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: A message explaining the error reported by the service. ,
Required: False ,
}
string ,
}
,
}
DetectLastPoint (removed)
Description :  This operation generates a model using points before the latest one. With this method, only historical points are used to determine whether the target point is an anomaly. The latest point detecting operation matches the scenario of real-time monitoring of business metrics.
Reference :  Link ¶

⚼ Request

POST:  /timeseries/last/detect
{
body:
{
Description: Time series points and period if needed. Advanced model parameters can also be set in the request. ,
Required: True ,
}
{
series:
{
Description: Time series data points. Points should be sorted by timestamp in ascending order to match the anomaly detection result. If the data is not sorted correctly or there is duplicated timestamp, the API will not work. In such case, an error message will be returned. ,
Required: True ,
}
[
{
timestamp:
{
Description: Optional argument, timestamp of a data point (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
value:
{
Description: The measurement of that point, should be float. ,
Format: float ,
Required: True ,
}
number ,
}
,
]
,
granularity:
{
Description: Optional argument, can be one of yearly, monthly, weekly, daily, hourly, minutely, secondly, microsecond or none. If granularity is not present, it will be none by default. If granularity is none, the timestamp property in time series point can be absent. ,
Enum:
{
yearly: No description available. ,
monthly: No description available. ,
weekly: No description available. ,
daily: No description available. ,
hourly: No description available. ,
minutely: No description available. ,
secondly: No description available. ,
microsecond: No description available. ,
none: No description available. ,
}
,
Required: False ,
}
enum ,
customInterval:
{
Description: Custom Interval is used to set non-standard time interval, for example, if the series is 5 minutes, request can be set as {"granularity":"minutely", "customInterval":5}. ,
Format: int32 ,
Required: False ,
}
integer ,
period:
{
Description: Optional argument, periodic value of a time series. If the value is null or does not present, the API will determine the period automatically. ,
Format: int32 ,
Required: False ,
}
integer ,
maxAnomalyRatio:
{
Description: Optional argument, advanced model parameter, max anomaly ratio in a time series. ,
Format: float ,
Required: False ,
}
number ,
sensitivity:
{
Description: Optional argument, advanced model parameter, between 0-99, the lower the value is, the larger the margin value will be which means less anomalies will be accepted. ,
Format: int32 ,
Required: False ,
}
integer ,
imputeMode:
{
Description: Used to specify how to deal with missing values in the input series, it's used when granularity is not "none". ,
Enum:
{
auto: No description available. ,
previous: No description available. ,
linear: No description available. ,
fixed: No description available. ,
zero: No description available. ,
notFill: No description available. ,
}
,
Required: False ,
}
enum ,
imputeFixedValue:
{
Description: Used to specify the value to fill, it's used when granularity is not "none" and imputeMode is "fixed". ,
Format: float ,
Required: False ,
}
number ,
}
,
}

⚐ Response (200)

{
period:
{
Description: Frequency extracted from the series, zero means no recurrent pattern has been found. ,
Format: int32 ,
Required: True ,
}
integer ,
suggestedWindow:
{
Description: Suggested input series points needed for detecting the latest point. ,
Format: int32 ,
Required: True ,
}
integer ,
expectedValue:
{
Description: Expected value of the latest point. ,
Format: float ,
Required: True ,
}
number ,
upperMargin:
{
Description: Upper margin of the latest point. UpperMargin is used to calculate upperBoundary, which equals to expectedValue + (100 - marginScale)*upperMargin. If the value of latest point is between upperBoundary and lowerBoundary, it should be treated as normal value. By adjusting marginScale value, anomaly status of latest point can be changed. ,
Format: float ,
Required: True ,
}
number ,
lowerMargin:
{
Description: Lower margin of the latest point. LowerMargin is used to calculate lowerBoundary, which equals to expectedValue - (100 - marginScale)*lowerMargin. ,
Format: float ,
Required: True ,
}
number ,
isAnomaly:
{
Description: Anomaly status of the latest point, true means the latest point is an anomaly either in negative direction or positive direction. ,
Required: True ,
}
boolean ,
isNegativeAnomaly:
{
Description: Anomaly status in negative direction of the latest point. True means the latest point is an anomaly and its real value is smaller than the expected one. ,
Required: True ,
}
boolean ,
isPositiveAnomaly:
{
Description: Anomaly status in positive direction of the latest point. True means the latest point is an anomaly and its real value is larger than the expected one. ,
Required: True ,
}
boolean ,
severity:
{
Description: The severity score for the last input point. The larger the value is, the more sever the anomaly is. For normal points, the "severity" is always 0. ,
Format: float ,
Required: False ,
}
number ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: error code ,
}
string ,
}
,
$schema:
{
Description: Error information returned by the API. ,
}
{
code:
{
Description: The error code. ,
Enum:
{
InvalidCustomInterval: No description available. ,
BadArgument: No description available. ,
InvalidGranularity: No description available. ,
InvalidPeriod: No description available. ,
InvalidModelArgument: No description available. ,
InvalidSeries: No description available. ,
InvalidJsonFormat: No description available. ,
RequiredGranularity: No description available. ,
RequiredSeries: No description available. ,
InvalidImputeMode: No description available. ,
InvalidImputeFixedValue: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: A message explaining the error reported by the service. ,
Required: False ,
}
string ,
}
,
}
DetectChangePoint (removed)
Description :  Evaluate change point score of every series point
Reference :  Link ¶

⚼ Request

POST:  /timeseries/changepoint/detect
{
body:
{
Description: Time series points and granularity is needed. Advanced model parameters can also be set in the request if needed. ,
Required: True ,
}
{
series:
{
Description: Time series data points. Points should be sorted by timestamp in ascending order to match the change point detection result. ,
Required: True ,
}
[
{
timestamp:
{
Description: Optional argument, timestamp of a data point (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
value:
{
Description: The measurement of that point, should be float. ,
Format: float ,
Required: True ,
}
number ,
}
,
]
,
granularity:
{
Description: Can only be one of yearly, monthly, weekly, daily, hourly, minutely or secondly. Granularity is used for verify whether input series is valid. ,
Enum:
{
yearly: No description available. ,
monthly: No description available. ,
weekly: No description available. ,
daily: No description available. ,
hourly: No description available. ,
minutely: No description available. ,
secondly: No description available. ,
microsecond: No description available. ,
none: No description available. ,
}
,
Required: True ,
}
enum ,
customInterval:
{
Description: Custom Interval is used to set non-standard time interval, for example, if the series is 5 minutes, request can be set as {"granularity":"minutely", "customInterval":5}. ,
Format: int32 ,
Required: False ,
}
integer ,
period:
{
Description: Optional argument, periodic value of a time series. If the value is null or does not present, the API will determine the period automatically. ,
Format: int32 ,
Required: False ,
}
integer ,
stableTrendWindow:
{
Description: Optional argument, advanced model parameter, a default stableTrendWindow will be used in detection. ,
Format: int32 ,
Required: False ,
}
integer ,
threshold:
{
Description: Optional argument, advanced model parameter, between 0.0-1.0, the lower the value is, the larger the trend error will be which means less change point will be accepted. ,
Format: float ,
Required: False ,
}
number ,
}
,
}

⚐ Response (200)

{
period:
{
Description: Frequency extracted from the series, zero means no recurrent pattern has been found. ,
Format: int32 ,
Required: False ,
}
integer ,
isChangePoint:
{
Description: isChangePoint contains change point properties for each input point. True means an anomaly either negative or positive has been detected. The index of the array is consistent with the input series. ,
Required: False ,
}
[
boolean ,
]
,
confidenceScores:
{
Description: the change point confidence of each point ,
Required: False ,
}
[
number ,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: error code ,
}
string ,
}
,
$schema:
{
Description: Error information returned by the API. ,
}
{
code:
{
Description: The error code. ,
Enum:
{
InvalidCustomInterval: No description available. ,
BadArgument: No description available. ,
InvalidGranularity: No description available. ,
InvalidPeriod: No description available. ,
InvalidModelArgument: No description available. ,
InvalidSeries: No description available. ,
InvalidJsonFormat: No description available. ,
RequiredGranularity: No description available. ,
RequiredSeries: No description available. ,
InvalidImputeMode: No description available. ,
InvalidImputeFixedValue: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: A message explaining the error reported by the service. ,
Required: False ,
}
string ,
}
,
}
TrainMultivariateModel (removed)
Description :  Create and train a multivariate anomaly detection model. The request must include a source parameter to indicate an externally accessible Azure storage Uri (preferably a Shared Access Signature Uri). All time-series used in generate the model must be zipped into one single file. Each time-series will be in a single CSV file in which the first column is timestamp and the second column is value.
Reference :  Link ¶

⚼ Request

POST:  /multivariate/models
{
body:
{
Description: Training request ,
Required: True ,
}
{
slidingWindow:
{
Description: An optional field, indicating how many previous points will be used to compute the anomaly score of the subsequent point. ,
Required: False ,
}
integer ,
alignPolicy:
{
Required: False ,
}
{
alignMode:
{
Description: An optional field, indicating how we align different variables to the same time-range. Either Inner or Outer. ,
Enum:
{
Inner: No description available. ,
Outer: No description available. ,
}
,
Required: False ,
}
enum ,
fillNAMethod:
{
Description: An optional field, indicating how missing values will be filled. One of Previous, Subsequent, Linear, Zero, Fixed, and NotFill. Cannot be set to NotFill, when the alignMode is Outer. ,
Enum:
{
Previous: No description available. ,
Subsequent: No description available. ,
Linear: No description available. ,
Zero: No description available. ,
Fixed: No description available. ,
NotFill: No description available. ,
}
,
Required: False ,
}
enum ,
paddingValue:
{
Description: An optional field. Required when fillNAMethod is Fixed. ,
Required: False ,
}
number ,
}
,
source:
{
Description: Source link to the input variables. Each variable should be a csv file with two columns, `timestamp` and `value`. By default, the file name of the variable will be used as its variable name. ,
Required: True ,
}
string ,
startTime:
{
Description: A required field, indicating the start time of training data. Should be date-time. ,
Format: date-time ,
Required: True ,
}
string ,
endTime:
{
Description: A required field, indicating the end time of training data. Should be date-time. ,
Format: date-time ,
Required: True ,
}
string ,
displayName:
{
Description: An optional field. The name of the model whose maximum length is 24. ,
Required: False ,
}
string ,
status:
{
Description: Model training status. ,
Enum:
{
CREATED: No description available. ,
RUNNING: No description available. ,
READY: No description available. ,
FAILED: No description available. ,
}
,
Required: False ,
}
enum ,
errors:
{
Description: Error messages when failed to create a model. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The message explaining the error reported by the service. ,
Required: True ,
}
string ,
}
,
]
,
diagnosticsInfo:
{
Required: False ,
}
{
modelState:
{
Required: False ,
}
{
epochIds:
{
Description: Epoch id ,
Required: False ,
}
[
integer ,
]
,
trainLosses:
{
Required: False ,
}
[
number ,
]
,
validationLosses:
{
Required: False ,
}
[
number ,
]
,
latenciesInSeconds:
{
Required: False ,
}
[
number ,
]
,
}
,
variableStates:
{
Required: False ,
}
[
{
variable:
{
Description: Variable name. ,
Required: False ,
}
string ,
filledNARatio:
{
Description: Proportion of NaN values filled of the variable. ,
Required: False ,
}
number ,
effectiveCount:
{
Description: Number of effective points counted. ,
Required: False ,
}
integer ,
startTime:
{
Description: Start time of the variable. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of the variable. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (201)

{
location:
{
Description: Location and ID of the model. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: error code ,
}
string ,
}
,
$schema:
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The message explaining the error reported by the service. ,
Required: True ,
}
string ,
}
,
}
ListMultivariateModel (removed)
Description :  List models of a subscription
Reference :  Link ¶

⚼ Request

GET:  /multivariate/models
{
$skip:
{
Description: $skip indicates how many models will be skipped. ,
Required: False ,
}
integer ,
$top:
{
Description: $top indicates how many models will be fetched. ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
models:
{
Description: List of models ,
Required: True ,
}
[
{
modelId:
{
Description: Model identifier. ,
Format: uuid ,
Required: True ,
}
string ,
createdTime:
{
Description: Date and time (UTC) when the model was created. ,
Format: date-time ,
Required: True ,
}
string ,
lastUpdatedTime:
{
Description: Date and time (UTC) when the model was last updated. ,
Format: date-time ,
Required: True ,
}
string ,
status:
{
Description: Model training status. ,
Enum:
{
CREATED: No description available. ,
RUNNING: No description available. ,
READY: No description available. ,
FAILED: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Required: False ,
}
string ,
variablesCount:
{
Description: Total number of variables. ,
Required: True ,
}
integer ,
}
,
]
,
currentCount:
{
Description: Current count of trained multivariate models. ,
Required: True ,
}
integer ,
maxCount:
{
Description: Max number of models that can be trained for this subscription. ,
Required: True ,
}
integer ,
nextLink:
{
Description: The link to fetch more models. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: error code ,
}
string ,
}
,
$schema:
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The message explaining the error reported by the service. ,
Required: True ,
}
string ,
}
,
}
GetMultivariateModel (removed)
Description :  Get detailed information of multivariate model, including the training status and variables used in the model.
Reference :  Link ¶

⚼ Request

GET:  /multivariate/models/{modelId}
{
modelId:
{
Description: Model identifier. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
modelId:
{
Description: Model identifier. ,
Format: uuid ,
Required: True ,
}
string ,
createdTime:
{
Description: Date and time (UTC) when the model was created. ,
Format: date-time ,
Required: True ,
}
string ,
lastUpdatedTime:
{
Description: Date and time (UTC) when the model was last updated. ,
Format: date-time ,
Required: True ,
}
string ,
modelInfo:
{
Description: Train result of a model including status, errors and diagnose info for model and variables. ,
Required: False ,
}
{
slidingWindow:
{
Description: An optional field, indicating how many previous points will be used to compute the anomaly score of the subsequent point. ,
Required: False ,
}
integer ,
alignPolicy:
{
Required: False ,
}
{
alignMode:
{
Description: An optional field, indicating how we align different variables to the same time-range. Either Inner or Outer. ,
Enum:
{
Inner: No description available. ,
Outer: No description available. ,
}
,
Required: False ,
}
enum ,
fillNAMethod:
{
Description: An optional field, indicating how missing values will be filled. One of Previous, Subsequent, Linear, Zero, Fixed, and NotFill. Cannot be set to NotFill, when the alignMode is Outer. ,
Enum:
{
Previous: No description available. ,
Subsequent: No description available. ,
Linear: No description available. ,
Zero: No description available. ,
Fixed: No description available. ,
NotFill: No description available. ,
}
,
Required: False ,
}
enum ,
paddingValue:
{
Description: An optional field. Required when fillNAMethod is Fixed. ,
Required: False ,
}
number ,
}
,
source:
{
Description: Source link to the input variables. Each variable should be a csv file with two columns, `timestamp` and `value`. By default, the file name of the variable will be used as its variable name. ,
Required: True ,
}
string ,
startTime:
{
Description: A required field, indicating the start time of training data. Should be date-time. ,
Format: date-time ,
Required: True ,
}
string ,
endTime:
{
Description: A required field, indicating the end time of training data. Should be date-time. ,
Format: date-time ,
Required: True ,
}
string ,
displayName:
{
Description: An optional field. The name of the model whose maximum length is 24. ,
Required: False ,
}
string ,
status:
{
Description: Model training status. ,
Enum:
{
CREATED: No description available. ,
RUNNING: No description available. ,
READY: No description available. ,
FAILED: No description available. ,
}
,
Required: False ,
}
enum ,
errors:
{
Description: Error messages when failed to create a model. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The message explaining the error reported by the service. ,
Required: True ,
}
string ,
}
,
]
,
diagnosticsInfo:
{
Required: False ,
}
{
modelState:
{
Required: False ,
}
{
epochIds:
{
Description: Epoch id ,
Required: False ,
}
[
integer ,
]
,
trainLosses:
{
Required: False ,
}
[
number ,
]
,
validationLosses:
{
Required: False ,
}
[
number ,
]
,
latenciesInSeconds:
{
Required: False ,
}
[
number ,
]
,
}
,
variableStates:
{
Required: False ,
}
[
{
variable:
{
Description: Variable name. ,
Required: False ,
}
string ,
filledNARatio:
{
Description: Proportion of NaN values filled of the variable. ,
Required: False ,
}
number ,
effectiveCount:
{
Description: Number of effective points counted. ,
Required: False ,
}
integer ,
startTime:
{
Description: Start time of the variable. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of the variable. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: error code ,
}
string ,
}
,
$schema:
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The message explaining the error reported by the service. ,
Required: True ,
}
string ,
}
,
}
DeleteMultivariateModel (removed)
Description :  Delete an existing multivariate model according to the modelId
Reference :  Link ¶

⚼ Request

DELETE:  /multivariate/models/{modelId}
{
modelId:
{
Description: Model identifier. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: error code ,
}
string ,
}
,
$schema:
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The message explaining the error reported by the service. ,
Required: True ,
}
string ,
}
,
}
DetectAnomaly (removed)
Description :  Submit detection multivariate anomaly task with the trained model of modelId, the input schema should be the same with the training request. Thus request will be complete asynchronously and will return a resultId for querying the detection result.The request should be a source link to indicate an externally accessible Azure storage Uri (preferably a Shared Access Signature Uri). All time-series used in generate the model must be zipped into one single file. Each time-series will be as follows: the first column is timestamp and the second column is value.
Reference :  Link ¶

⚼ Request

POST:  /multivariate/models/{modelId}/detect
{
modelId:
{
Description: Model identifier. ,
Format: uuid ,
Required: True ,
}
string ,
body:
{
Description: Detect anomaly request ,
Required: True ,
}
{
source:
{
Description: Source link to the input variables. Each variable should be a csv with two columns, `timestamp` and `value`. The file name of the variable will be used as its name. The variables used in detection should be exactly the same with those used in the training phase. ,
Required: True ,
}
string ,
startTime:
{
Description: A required field, indicating the start time of data for detection. Should be date-time. ,
Format: date-time ,
Required: True ,
}
string ,
endTime:
{
Description: A required field, indicating the end time of data for detection. Should be date-time. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
}

⚐ Response (201)

{
location:
{
Description: Location and ID of the detection result. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: error code ,
}
string ,
}
,
$schema:
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The message explaining the error reported by the service. ,
Required: True ,
}
string ,
}
,
}
GetDetectionResult (removed)
Description :  Get multivariate anomaly detection result based on resultId returned by the DetectAnomalyAsync api
Reference :  Link ¶

⚼ Request

GET:  /multivariate/results/{resultId}
{
resultId:
{
Description: Result identifier. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
resultId:
{
Format: uuid ,
Required: True ,
}
string ,
summary:
{
Required: True ,
}
{
status:
{
Description: Status of detection results. One of CREATED, RUNNING, READY, and FAILED. ,
Enum:
{
CREATED: No description available. ,
RUNNING: No description available. ,
READY: No description available. ,
FAILED: No description available. ,
}
,
Required: True ,
}
enum ,
errors:
{
Description: Error message when detection is failed. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The message explaining the error reported by the service. ,
Required: True ,
}
string ,
}
,
]
,
variableStates:
{
Required: False ,
}
[
{
variable:
{
Description: Variable name. ,
Required: False ,
}
string ,
filledNARatio:
{
Description: Proportion of NaN values filled of the variable. ,
Required: False ,
}
number ,
effectiveCount:
{
Description: Number of effective points counted. ,
Required: False ,
}
integer ,
startTime:
{
Description: Start time of the variable. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of the variable. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
setupInfo:
{
Description: Detection request. ,
Required: True ,
}
{
source:
{
Description: Source link to the input variables. Each variable should be a csv with two columns, `timestamp` and `value`. The file name of the variable will be used as its name. The variables used in detection should be exactly the same with those used in the training phase. ,
Required: True ,
}
string ,
startTime:
{
Description: A required field, indicating the start time of data for detection. Should be date-time. ,
Format: date-time ,
Required: True ,
}
string ,
endTime:
{
Description: A required field, indicating the end time of data for detection. Should be date-time. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
}
,
results:
{
Description: Detection result for each timestamp. ,
Required: True ,
}
[
{
timestamp:
{
Description: timestamp ,
Format: date-time ,
Required: True ,
}
string ,
value:
{
Required: False ,
}
{
isAnomaly:
{
Description: True if an anomaly is detected at the current timestamp. ,
Required: True ,
}
boolean ,
severity:
{
Description: Indicates the significance of the anomaly. The higher the severity, the more significant the anomaly. ,
Required: True ,
}
number ,
score:
{
Description: Raw score from the model. ,
Required: True ,
}
number ,
interpretation:
{
Required: False ,
}
[
{
variable:
{
Required: False ,
}
string ,
contributionScore:
{
Required: False ,
}
number ,
correlationChanges:
{
Required: False ,
}
{
changedVariables:
{
Description: correlated variables ,
Required: False ,
}
[
string ,
]
,
changedValues:
{
Description: changes in correlation ,
Required: False ,
}
[
number ,
]
,
}
,
}
,
]
,
}
,
errors:
{
Description: Error message for the current timestamp ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The message explaining the error reported by the service. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: error code ,
}
string ,
}
,
$schema:
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The message explaining the error reported by the service. ,
Required: True ,
}
string ,
}
,
}
ExportModel (removed)
Description :  Export multivariate anomaly detection model based on modelId
Reference :  Link ¶

⚼ Request

GET:  /multivariate/models/{modelId}/export
{
modelId:
{
Description: Model identifier. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Format: binary ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: error code ,
}
string ,
}
,
$schema:
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The message explaining the error reported by the service. ,
Required: True ,
}
string ,
}
,
}
LastDetectAnomaly (removed)
Description :  Synchronized API for anomaly detection.
Reference :  Link ¶

⚼ Request

POST:  /multivariate/models/{modelId}/last/detect
{
modelId:
{
Description: Model identifier. ,
Format: uuid ,
Required: True ,
}
string ,
body:
{
Description: Request for last detection. ,
Required: True ,
}
{
variables:
{
Description: variables ,
Required: True ,
}
[
{
name:
{
Description: variable name ,
Required: True ,
}
string ,
timestamps:
{
Description: timestamps ,
Required: True ,
}
[
string ,
]
,
values:
{
Description: values ,
Required: True ,
}
[
number ,
]
,
}
,
]
,
detectingPoints:
{
Description: number of timestamps on which the model detects ,
Required: True ,
}
integer ,
}
,
}

⚐ Response (200)

{
variableStates:
{
Required: False ,
}
[
{
variable:
{
Description: Variable name. ,
Required: False ,
}
string ,
filledNARatio:
{
Description: Proportion of NaN values filled of the variable. ,
Required: False ,
}
number ,
effectiveCount:
{
Description: Number of effective points counted. ,
Required: False ,
}
integer ,
startTime:
{
Description: Start time of the variable. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of the variable. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
results:
{
Required: False ,
}
[
{
timestamp:
{
Description: timestamp ,
Format: date-time ,
Required: True ,
}
string ,
value:
{
Required: False ,
}
{
isAnomaly:
{
Description: True if an anomaly is detected at the current timestamp. ,
Required: True ,
}
boolean ,
severity:
{
Description: Indicates the significance of the anomaly. The higher the severity, the more significant the anomaly. ,
Required: True ,
}
number ,
score:
{
Description: Raw score from the model. ,
Required: True ,
}
number ,
interpretation:
{
Required: False ,
}
[
{
variable:
{
Required: False ,
}
string ,
contributionScore:
{
Required: False ,
}
number ,
correlationChanges:
{
Required: False ,
}
{
changedVariables:
{
Description: correlated variables ,
Required: False ,
}
[
string ,
]
,
changedValues:
{
Description: changes in correlation ,
Required: False ,
}
[
number ,
]
,
}
,
}
,
]
,
}
,
errors:
{
Description: Error message for the current timestamp ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The message explaining the error reported by the service. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: error code ,
}
string ,
}
,
$schema:
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The message explaining the error reported by the service. ,
Required: True ,
}
string ,
}
,
}
CreateRootCauseAnalysisDataSet (removed)
Description :  Create a root cause analysis data set
Reference :  Link ¶

⚼ Request

PUT:  /rootCauseAnalysis/dataSets/{dataSetId}
{
dataSetId:
{
Description: The root cause analysis data set unique id, should be a string of uuid ,
Format: uuid ,
Required: True ,
}
string ,
body:
{
Description: create a root cause analysis data set request ,
Required: True ,
}
{
kind:
{
Description: Root cause analysis kind ,
Enum:
{
multidimensional: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: Root cause analysis data set name ,
Required: True ,
}
string ,
}
,
}

⚐ Response (201)

{
location:
{
Description: Location of the newly created resource. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: error code ,
}
string ,
}
,
$schema:
{
message:
{
Description: Human-readable error message ,
Required: False ,
}
string ,
code:
{
Description: Error code ,
Required: False ,
}
string ,
}
,
}
GetRootCauseAnalysisDataSet (removed)
Description :  Get a root cause analysis data set by its id
Reference :  Link ¶

⚼ Request

GET:  /rootCauseAnalysis/dataSets/{dataSetId}
{
dataSetId:
{
Description: The root cause analysis data set unique id, should be a string of uuid ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Root cause analysis kind ,
Enum:
{
multidimensional: No description available. ,
}
,
Required: True ,
}
enum ,
dataSetId:
{
Description: Root cause analysis data set unique ID ,
Format: uuid ,
Required: True ,
}
string ,
displayName:
{
Description: Root cause analysis data set name ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: error code ,
}
string ,
}
,
$schema:
{
message:
{
Description: Human-readable error message ,
Required: False ,
}
string ,
code:
{
Description: Error code ,
Required: False ,
}
string ,
}
,
}
DeleteRootCauseAnalysisDataSet (removed)
Description :  Delete a root cause analysis data set
Reference :  Link ¶

⚼ Request

DELETE:  /rootCauseAnalysis/dataSets/{dataSetId}
{
dataSetId:
{
Description: The root cause analysis data set unique id, should be a string of uuid ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: error code ,
}
string ,
}
,
$schema:
{
message:
{
Description: Human-readable error message ,
Required: False ,
}
string ,
code:
{
Description: Error code ,
Required: False ,
}
string ,
}
,
}
ListRootCauseAnalysisDataSets (removed)
Description :  List root cause analysis data sets
Reference :  Link ¶

⚼ Request

GET:  /rootCauseAnalysis/dataSets
{
skip:
{
Description: For paging, skipped number ,
Format: int32 ,
Required: False ,
}
integer ,
maxpagesize:
{
Description: The maximum number of items in one page ,
Format: int32 ,
Required: False ,
}
integer ,
filter:
{
Description: The filter expression filters out the resources to be returned, currently contains(displayName, 'filter name’) is supported ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: Link of next page, only provided when there are next pages ,
Required: False ,
}
string ,
value:
{
Description: Response values ,
Required: True ,
}
[
{
kind:
{
Description: Root cause analysis kind ,
Enum:
{
multidimensional: No description available. ,
}
,
Required: True ,
}
enum ,
dataSetId:
{
Description: Root cause analysis data set unique ID ,
Format: uuid ,
Required: True ,
}
string ,
displayName:
{
Description: Root cause analysis data set name ,
Required: True ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: error code ,
}
string ,
}
,
$schema:
{
message:
{
Description: Human-readable error message ,
Required: False ,
}
string ,
code:
{
Description: Error code ,
Required: False ,
}
string ,
}
,
}
UploadRootCauseAnalysisDataByPartition (removed)
Description :  Upload data to root cause analysis data set by partition
Reference :  Link ¶

⚼ Request

PUT:  /rootCauseAnalysis/dataSets/{dataSetId}/timestamps/{timestamp}/partitions/{partitionId}
{
dataSetId:
{
Description: The root cause analysis data set unique id. Should be a string of uuid ,
Format: uuid ,
Required: True ,
}
string ,
timestamp:
{
Description: Timestamp of the data, should be a string of ISO format ,
Format: date-time ,
Required: True ,
}
string ,
partitionId:
{
Description: The partition unique id，should be a string of uuid ,
Format: uuid ,
Required: True ,
}
string ,
body:
{
Description: Data to be uploaded to perform root cause analysis ,
Required: True ,
}
{
kind:
{
Description: Root cause analysis kind ,
Enum:
{
multidimensional: No description available. ,
}
,
Required: True ,
}
enum ,
data:
{
Description: Root cause data detail, the first few columns should be the dimension value. the last few columns should be the measure values. For the value doesn't exist, use null to define it. ,
Required: True ,
}
[
object ,
]
,
}
,
}

⚐ Response (201)

{
location:
{
Description: Location of the newly created resource. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: error code ,
}
string ,
}
,
$schema:
{
message:
{
Description: Human-readable error message ,
Required: False ,
}
string ,
code:
{
Description: Error code ,
Required: False ,
}
string ,
}
,
}
DeleteRootCauseAnalysisDataByPartitionId (removed)
Description :  Delete root cause analysis data by partition Id
Reference :  Link ¶

⚼ Request

DELETE:  /rootCauseAnalysis/dataSets/{dataSetId}/timestamps/{timestamp}/partitions/{partitionId}
{
dataSetId:
{
Description: Data set unique id，should be a string of uuid ,
Format: uuid ,
Required: True ,
}
string ,
timestamp:
{
Description: The time stamp to be queried, should be a string of ISO format ,
Format: date-time ,
Required: True ,
}
string ,
partitionId:
{
Description: Data partition unique id，should be a string of uuid ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: error code ,
}
string ,
}
,
$schema:
{
message:
{
Description: Human-readable error message ,
Required: False ,
}
string ,
code:
{
Description: Error code ,
Required: False ,
}
string ,
}
,
}
UploadRootCauseAnalysisDataByBlock (removed)
Description :  Upload data to root cause analysis data set by block
Reference :  Link ¶

⚼ Request

POST:  /rootCauseAnalysis/dataSets/{dataSetId}/timestamps:upload
{
dataSetId:
{
Description: The root cause analysis data set unique id，should be a string of uuid ,
Format: uuid ,
Required: True ,
}
string ,
body:
{
Description: Data to be uploaded to perform root cause analysis ,
Required: True ,
}
{
kind:
{
Description: Root cause analysis kind ,
Enum:
{
multidimensional: No description available. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Root cause analysis data ,
Required: True ,
}
[
{
partitionId:
{
Description: Root cause analysis data partition unique ID ,
Format: uuid ,
Required: True ,
}
string ,
timestamp:
{
Description: Root cause analysis date time of the data (UTC) ,
Format: date-time ,
Required: True ,
}
string ,
data:
{
Description: Root cause data detail, the first few columns should be the dimension value. the last few columns should be the measure values ,
Required: True ,
}
[
object ,
]
,
}
,
]
,
}
,
}

⚐ Response (201)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: error code ,
}
string ,
}
,
$schema:
{
message:
{
Description: Human-readable error message ,
Required: False ,
}
string ,
code:
{
Description: Error code ,
Required: False ,
}
string ,
}
,
}
DeleteRootCauseAnalysisDataByTimeRange (removed)
Description :  Delete root cause analysis data by time range
Reference :  Link ¶

⚼ Request

POST:  /rootCauseAnalysis/dataSets/{dataSetId}/timestamps:purge
{
dataSetId:
{
Description: The root cause analysis data set unique id，should be a string of uuid ,
Format: uuid ,
Required: True ,
}
string ,
start:
{
Description: Start date time, should be ISO format ,
Required: False ,
}
string ,
end:
{
Description: End date time, should be ISO format ,
Required: False ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: error code ,
}
string ,
}
,
$schema:
{
message:
{
Description: Human-readable error message ,
Required: False ,
}
string ,
code:
{
Description: Error code ,
Required: False ,
}
string ,
}
,
}
ListRootCauseAnalysisDataMetaByTimestamp (removed)
Description :  List data meta for a given timestamp
Reference :  Link ¶

⚼ Request

GET:  /rootCauseAnalysis/dataSets/{dataSetId}/timestamps/{timestamp}/partitions
{
dataSetId:
{
Description: The root cause analysis data set unique id, should be a string of uuid ,
Format: uuid ,
Required: True ,
}
string ,
timestamp:
{
Description: The time stamp to be queried, should be a string of ISO format ,
Format: date-time ,
Required: True ,
}
string ,
skip:
{
Description: For paging, skipped number ,
Format: int32 ,
Required: False ,
}
integer ,
maxpagesize:
{
Description: The maximum number of items in one page ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
nextLink:
{
Description: Link of next page, only provided when there are next pages ,
Required: False ,
}
string ,
value:
{
Description: Response values ,
Required: True ,
}
[
{
partitionId:
{
Description: Root cause analysis partition ID ,
Format: uuid ,
Required: True ,
}
string ,
rowCount:
{
Description: Root cause analysis data row count in the partition ID ,
Format: int32 ,
Required: True ,
}
integer ,
timestamp:
{
Description: Root cause date time of the data (UTC) ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedDateTime:
{
Description: Root cause data last updated time (UTC) ,
Format: date-time ,
Required: True ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: error code ,
}
string ,
}
,
$schema:
{
message:
{
Description: Human-readable error message ,
Required: False ,
}
string ,
code:
{
Description: Error code ,
Required: False ,
}
string ,
}
,
}
ListRootCauseAnalysisDataMetaByTimeRange (removed)
Description :  List data meta
Reference :  Link ¶

⚼ Request

GET:  /rootCauseAnalysis/dataSets/{dataSetId}/timestamps
{
dataSetId:
{
Description: The root cause analysis data set unique id, should be a string of uuid ,
Format: uuid ,
Required: True ,
}
string ,
skip:
{
Description: For paging, skipped number ,
Format: int32 ,
Required: False ,
}
integer ,
maxpagesize:
{
Description: The maximum number of items in one page ,
Format: int32 ,
Required: False ,
}
integer ,
filter:
{
Description: The filter expression filters out the resources, currently 2 kinds of operation are supported. They are timestamp ge XXXX and timestamp le XXXX. Timestamp must be ISO format ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: Link of next page, only provided when there are next pages ,
Required: False ,
}
string ,
value:
{
Description: Response values ,
Required: True ,
}
[
{
partitionId:
{
Description: Root cause analysis partition ID ,
Format: uuid ,
Required: True ,
}
string ,
rowCount:
{
Description: Root cause analysis data row count in the partition ID ,
Format: int32 ,
Required: True ,
}
integer ,
timestamp:
{
Description: Root cause date time of the data (UTC) ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedDateTime:
{
Description: Root cause data last updated time (UTC) ,
Format: date-time ,
Required: True ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: error code ,
}
string ,
}
,
$schema:
{
message:
{
Description: Human-readable error message ,
Required: False ,
}
string ,
code:
{
Description: Error code ,
Required: False ,
}
string ,
}
,
}
CreateRootCauseAnalysisInstance (removed)
Description :  Create an instance for root cause analysis
Reference :  Link ¶

⚼ Request

PUT:  /rootCauseAnalysis/instances/{instanceId}
{
instanceId:
{
Description: Instance unique id, should be a string of uuid. ,
Format: uuid ,
Required: True ,
}
string ,
body:
{
Description: Create a root cause analysis instance request ,
Required: True ,
}
{
kind:
{
Description: Root cause analysis type ,
Enum:
{
multidimensional: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: Instance name for root cause analysis ,
Required: True ,
}
string ,
}
,
}

⚐ Response (201)

{
location:
{
Description: Location of the newly created resource. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: error code ,
}
string ,
}
,
$schema:
{
message:
{
Description: Human-readable error message ,
Required: False ,
}
string ,
code:
{
Description: Error code ,
Required: False ,
}
string ,
}
,
}
GetRootCauseAnalysisInstance (removed)
Description :  Query an instance information for root cause analysis
Reference :  Link ¶

⚼ Request

GET:  /rootCauseAnalysis/instances/{instanceId}
{
instanceId:
{
Description: Instance unique id, should be a string of uuid. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Root cause analysis type ,
Enum:
{
multidimensional: No description available. ,
}
,
Required: True ,
}
enum ,
instanceId:
{
Description: Instance unique ID for root cause analysis ,
Format: uuid ,
Required: True ,
}
string ,
displayName:
{
Description: Instance name for root cause analysis ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: error code ,
}
string ,
}
,
$schema:
{
message:
{
Description: Human-readable error message ,
Required: False ,
}
string ,
code:
{
Description: Error code ,
Required: False ,
}
string ,
}
,
}
DeleteRootCauseAnalysisInstance (removed)
Description :  Delete an instance for root cause analysis
Reference :  Link ¶

⚼ Request

DELETE:  /rootCauseAnalysis/instances/{instanceId}
{
instanceId:
{
Description: Instance unique id ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: error code ,
}
string ,
}
,
$schema:
{
message:
{
Description: Human-readable error message ,
Required: False ,
}
string ,
code:
{
Description: Error code ,
Required: False ,
}
string ,
}
,
}
ListRootCauseAnalysisInstances (removed)
Description :  Get instance list for root cause analysis
Reference :  Link ¶

⚼ Request

GET:  /rootCauseAnalysis/instances
{
skip:
{
Description: For paging, skipped number ,
Format: int32 ,
Required: False ,
}
integer ,
maxpagesize:
{
Description: The maximum number of items in one page ,
Format: int32 ,
Required: False ,
}
integer ,
filter:
{
Description: The filter expression filters out the resources to be returned, currently contains(displayName, 'filter name’) is supported ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: Link of next page, only provided when there are next pages ,
Required: False ,
}
string ,
value:
{
Description: Response values ,
Required: True ,
}
[
{
kind:
{
Description: Root cause analysis type ,
Enum:
{
multidimensional: No description available. ,
}
,
Required: True ,
}
enum ,
instanceId:
{
Description: Instance unique ID for root cause analysis ,
Format: uuid ,
Required: True ,
}
string ,
displayName:
{
Description: Instance name for root cause analysis ,
Required: True ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: error code ,
}
string ,
}
,
$schema:
{
message:
{
Description: Human-readable error message ,
Required: False ,
}
string ,
code:
{
Description: Error code ,
Required: False ,
}
string ,
}
,
}
ListRootCauseAnalysisKinds (removed)
Description :  Get kind list for root cause analysis
Reference :  Link ¶

⚼ Request

GET:  /rootCauseAnalysis/kinds
{}

⚐ Response (200)

{
kinds:
{
Description: Root cause analysis kind list ,
Required: True ,
}
[
string ,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: error code ,
}
string ,
}
,
$schema:
{
message:
{
Description: Human-readable error message ,
Required: False ,
}
string ,
code:
{
Description: Error code ,
Required: False ,
}
string ,
}
,
}
CreateRootCauseAnalysisTrainingTask (removed)
Description :  Create a training model for root cause analysis
Reference :  Link ¶

⚼ Request

PUT:  /rootCauseAnalysis/instances/{instanceId}/models/{modelId}
{
instanceId:
{
Description: Instance unique id, should be a string of uuid ,
Format: uuid ,
Required: True ,
}
string ,
modelId:
{
Description: Model unique id, should be a string of uuid ,
Format: uuid ,
Required: True ,
}
string ,
body:
{
Required: True ,
}
{
displayName:
{
Description: Model display name ,
Required: True ,
}
string ,
kind:
{
Description: Root cause analysis kind ,
Enum:
{
multidimensional: No description available. ,
}
,
Required: True ,
}
enum ,
parameter:
{
Description: Parameter for training ,
Required: True ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: Location of the newly created resource. ,
}
string ,
}
,
$schema:
{
taskId:
{
Description: Training task unique id for root cause analysis ,
Format: uuid ,
Required: True ,
}
string ,
instanceId:
{
Description: Instance unique id for root cause analysis ,
Format: uuid ,
Required: True ,
}
string ,
modelId:
{
Description: Model unique id for root cause analysis ,
Format: uuid ,
Required: True ,
}
string ,
displayName:
{
Description: Model name for root cause analysis ,
Required: True ,
}
string ,
kind:
{
Description: kind of root cause analysis ,
Enum:
{
multidimensional: No description available. ,
}
,
Required: True ,
}
enum ,
status:
{
Description: Training task status for root cause analysis ,
Enum:
{
scheduled: No description available. ,
running: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
canceled: No description available. ,
}
,
Required: True ,
}
enum ,
createdDateTime:
{
Description: Training task created date time (UTC) ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedDateTime:
{
Description: Training task state modified date time (UTC) ,
Format: date-time ,
Required: True ,
}
string ,
error:
{
Required: False ,
}
{
message:
{
Description: Human-readable error message ,
Required: False ,
}
string ,
code:
{
Description: Error code ,
Required: False ,
}
string ,
}
,
taskInfo:
{
Description: Training task information, if status is failed, this failed will not be shown ,
Required: False ,
}
string ,
parameter:
{
Description: Root cause analysis training parameter ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: error code ,
}
string ,
}
,
$schema:
{
message:
{
Description: Human-readable error message ,
Required: False ,
}
string ,
code:
{
Description: Error code ,
Required: False ,
}
string ,
}
,
}
DeleteRootCauseAnalysisModel (removed)
Description :  Delete a model for root cause analysis
Reference :  Link ¶

⚼ Request

DELETE:  /rootCauseAnalysis/instances/{instanceId}/models/{modelId}
{
instanceId:
{
Description: Instance unique id, should be a string of uuid. ,
Format: uuid ,
Required: True ,
}
string ,
modelId:
{
Description: Model unique id, should be a string of uuid. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: error code ,
}
string ,
}
,
$schema:
{
message:
{
Description: Human-readable error message ,
Required: False ,
}
string ,
code:
{
Description: Error code ,
Required: False ,
}
string ,
}
,
}
GetRootCauseAnalysisTrainingState (removed)
Description :  Query a training task state for root cause analysis
Reference :  Link ¶

⚼ Request

GET:  /rootCauseAnalysis/instances/{instanceId}/models/{modelId}
{
instanceId:
{
Description: Instance unique id, should be a string of uuid. ,
Format: uuid ,
Required: True ,
}
string ,
modelId:
{
Description: Model unique id, should be a string of uuid. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
taskId:
{
Description: Training task unique id for root cause analysis ,
Format: uuid ,
Required: True ,
}
string ,
instanceId:
{
Description: Instance unique id for root cause analysis ,
Format: uuid ,
Required: True ,
}
string ,
modelId:
{
Description: Model unique id for root cause analysis ,
Format: uuid ,
Required: True ,
}
string ,
displayName:
{
Description: Model name for root cause analysis ,
Required: True ,
}
string ,
kind:
{
Description: kind of root cause analysis ,
Enum:
{
multidimensional: No description available. ,
}
,
Required: True ,
}
enum ,
status:
{
Description: Training task status for root cause analysis ,
Enum:
{
scheduled: No description available. ,
running: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
canceled: No description available. ,
}
,
Required: True ,
}
enum ,
createdDateTime:
{
Description: Training task created date time (UTC) ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedDateTime:
{
Description: Training task state modified date time (UTC) ,
Format: date-time ,
Required: True ,
}
string ,
error:
{
Required: False ,
}
{
message:
{
Description: Human-readable error message ,
Required: False ,
}
string ,
code:
{
Description: Error code ,
Required: False ,
}
string ,
}
,
taskInfo:
{
Description: Training task information, if status is failed, this failed will not be shown ,
Required: False ,
}
string ,
parameter:
{
Description: Root cause analysis training parameter ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: error code ,
}
string ,
}
,
$schema:
{
message:
{
Description: Human-readable error message ,
Required: False ,
}
string ,
code:
{
Description: Error code ,
Required: False ,
}
string ,
}
,
}
ListRootCauseAnalysisTrainingStates (removed)
Description :  Query training task state list for root cause analysis
Reference :  Link ¶

⚼ Request

GET:  /rootCauseAnalysis/instances/{instanceId}/models
{
instanceId:
{
Description: Instance unique id, should be a string of uuid. ,
Format: uuid ,
Required: True ,
}
string ,
skip:
{
Description: For paging, skipped number ,
Format: int32 ,
Required: False ,
}
integer ,
maxpagesize:
{
Description: The maximum number of items in one page ,
Format: int32 ,
Required: False ,
}
integer ,
filter:
{
Description: The filter expression filters out the resources to be returned, currently contains(displayName, 'filter name’) is supported ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: Link of next page, only provided when there are next pages ,
Required: False ,
}
string ,
value:
{
Description: Response values ,
Required: True ,
}
[
{
taskId:
{
Description: Training task unique id for root cause analysis ,
Format: uuid ,
Required: True ,
}
string ,
instanceId:
{
Description: Instance unique id for root cause analysis ,
Format: uuid ,
Required: True ,
}
string ,
modelId:
{
Description: Model unique id for root cause analysis ,
Format: uuid ,
Required: True ,
}
string ,
displayName:
{
Description: Model name for root cause analysis ,
Required: True ,
}
string ,
kind:
{
Description: kind of root cause analysis ,
Enum:
{
multidimensional: No description available. ,
}
,
Required: True ,
}
enum ,
status:
{
Description: Training task status for root cause analysis ,
Enum:
{
scheduled: No description available. ,
running: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
canceled: No description available. ,
}
,
Required: True ,
}
enum ,
createdDateTime:
{
Description: Training task created date time (UTC) ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedDateTime:
{
Description: Training task state modified date time (UTC) ,
Format: date-time ,
Required: True ,
}
string ,
error:
{
Required: False ,
}
{
message:
{
Description: Human-readable error message ,
Required: False ,
}
string ,
code:
{
Description: Error code ,
Required: False ,
}
string ,
}
,
taskInfo:
{
Description: Training task information, if status is failed, this failed will not be shown ,
Required: False ,
}
string ,
parameter:
{
Description: Root cause analysis training parameter ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: error code ,
}
string ,
}
,
$schema:
{
message:
{
Description: Human-readable error message ,
Required: False ,
}
string ,
code:
{
Description: Error code ,
Required: False ,
}
string ,
}
,
}
CreateRootCauseAnalysisInferenceTask (removed)
Description :  Create an inference task for root cause analysis
Reference :  Link ¶

⚼ Request

PUT:  /rootCauseAnalysis/instances/{instanceId}/models/{modelId}/inferences/{inferenceId}
{
instanceId:
{
Description: Instance unique id, should be a string of uuid. ,
Format: uuid ,
Required: True ,
}
string ,
modelId:
{
Description: Model unique id, should be a string of uuid. ,
Format: uuid ,
Required: True ,
}
string ,
inferenceId:
{
Description: Inference unique id, should be a string of uuid. ,
Format: uuid ,
Required: True ,
}
string ,
body:
{
Description: Inference request of root cause analysis ,
Required: True ,
}
{
kind:
{
Description: Root cause analysis kind ,
Enum:
{
multidimensional: No description available. ,
}
,
Required: True ,
}
enum ,
parameter:
{
Description: Parameter for inference ,
Required: True ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: Location of the newly created resource. ,
}
string ,
}
,
$schema:
{
inferenceId:
{
Description: Inference unique id for root cause analysis ,
Format: uuid ,
Required: True ,
}
string ,
instanceId:
{
Description: Instance unique id for root cause analysis ,
Format: uuid ,
Required: True ,
}
string ,
modelId:
{
Description: Model unique id for root cause analysis ,
Format: uuid ,
Required: True ,
}
string ,
kind:
{
Description: Kind of root cause analysis ,
Enum:
{
multidimensional: No description available. ,
}
,
Required: True ,
}
enum ,
status:
{
Description: Inference task status for root cause analysis ,
Enum:
{
scheduled: No description available. ,
running: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
canceled: No description available. ,
}
,
Required: True ,
}
enum ,
createdDateTime:
{
Description: Inference task created date time (UTC) ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedDateTime:
{
Description: Inference task state last modified date time (UTC) ,
Format: date-time ,
Required: True ,
}
string ,
error:
{
Required: False ,
}
{
message:
{
Description: Human-readable error message ,
Required: False ,
}
string ,
code:
{
Description: Error code ,
Required: False ,
}
string ,
}
,
result:
{
Description: Root cause analysis inference result, if status is failed, this field wil not be shown ,
Required: False ,
}
string ,
parameter:
{
Description: Root cause analysis inference parameter ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: error code ,
}
string ,
}
,
$schema:
{
message:
{
Description: Human-readable error message ,
Required: False ,
}
string ,
code:
{
Description: Error code ,
Required: False ,
}
string ,
}
,
}
GetRootCauseAnalysisInferenceState (removed)
Description :  Query an inference task state for root cause analysis
Reference :  Link ¶

⚼ Request

GET:  /rootCauseAnalysis/instances/{instanceId}/models/{modelId}/inferences/{inferenceId}
{
instanceId:
{
Description: Instance unique id, should be a string of uuid. ,
Format: uuid ,
Required: True ,
}
string ,
modelId:
{
Description: Model unique id, should be a string of uuid. ,
Format: uuid ,
Required: True ,
}
string ,
inferenceId:
{
Description: Inference unique id, should be a string of uuid. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
inferenceId:
{
Description: Inference unique id for root cause analysis ,
Format: uuid ,
Required: True ,
}
string ,
instanceId:
{
Description: Instance unique id for root cause analysis ,
Format: uuid ,
Required: True ,
}
string ,
modelId:
{
Description: Model unique id for root cause analysis ,
Format: uuid ,
Required: True ,
}
string ,
kind:
{
Description: Kind of root cause analysis ,
Enum:
{
multidimensional: No description available. ,
}
,
Required: True ,
}
enum ,
status:
{
Description: Inference task status for root cause analysis ,
Enum:
{
scheduled: No description available. ,
running: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
canceled: No description available. ,
}
,
Required: True ,
}
enum ,
createdDateTime:
{
Description: Inference task created date time (UTC) ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedDateTime:
{
Description: Inference task state last modified date time (UTC) ,
Format: date-time ,
Required: True ,
}
string ,
error:
{
Required: False ,
}
{
message:
{
Description: Human-readable error message ,
Required: False ,
}
string ,
code:
{
Description: Error code ,
Required: False ,
}
string ,
}
,
result:
{
Description: Root cause analysis inference result, if status is failed, this field wil not be shown ,
Required: False ,
}
string ,
parameter:
{
Description: Root cause analysis inference parameter ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: error code ,
}
string ,
}
,
$schema:
{
message:
{
Description: Human-readable error message ,
Required: False ,
}
string ,
code:
{
Description: Error code ,
Required: False ,
}
string ,
}
,
}